This is the main entrance for information regarding the APIs to access the Prodibas system.
These are the API "formats" available:
The last two API formats have the same backend logic. Some of the functionality in the SOAP API is missing from the readonly REST API. Read more about the APIs here: Available APIs.
If you are a new user of the Prodibas APIs, please visit Getting started to get up and running.
The field Volume
is now added to productPackage.
For SEG, the field BulletText
is now obsolete and should not be used. It will always return null.
New property avaliable:
DualUseCode
ApiProduct
You can set and get DualUseCode = Dual Use (EU).
New method implemented in GlobalDataService, GetDualUseCodes()
.
New read-only property avaliable:
NonPhysical
ApiProduct
You can get NonPhysical = Icke fysisk.
Some uri types can now have "valid until" dates attached to them. See which types by using GlobalData GET /uritypes (for SOAP see GetUriTypes).
Please note that if you are currently using HTTP-endpoints for the SOAP services, we strongly recommend switching to using the HTTPS endpoints for all communication. See Note on HTTPS under Environments.
New read-only property avaliable:
NonPhysical
ApiProduct
You can get NonPhysical = Icke fysisk.
Some uri types can now have "valid until" dates attached to them. See which types by using GlobalData GET /uritypes (for SOAP see GetUriTypes).
Property ValidUntilEnabled
should be true for these types.
New REST API now has a patch endpoint for uris for updating only "valid until" date for an existing uri.
A new .NET SDK with sample usages of the new REST API is now available here: Examples
The new REST API is now available in the production environment. Read more here: Environments and here Available Apis.
One new ExtNumber type has been added to the reference list, but is not yet active in the system: EPR (EPREL regnr). When set and in use, it will be used to download the documents:
ENERGYMARKINGDOC (Produktblad energimärkning)
ENERGYMARKINGLABEL (Energimärkningsetikett)
NESTEDEML (Nästlad energimärkningsetikett)
Read more here: Reference lists
New property:
PrecisionWeight
EnvironmentalData
on ApiProduct
.
New property:
ConsistsOfNo
ApiArticleAccessory
.
You can set and get ConsistsOfNo = Består av antal, on the relation type ConsistsOf.
New properties:
EpdIdentifier
EpdReCalculationFactor
EnvironmentalData
on ApiProduct
.
If your company has EPD feature enabled, you can get and set these properties, otherwise they will always be null. Please contact support if you want to use these properties.
New read-only property StatisticGroup
on ApiProduct
. Will only ever contain value for SEG and if you have rights to view value.
The method GetManyByIdentifiersQueued in both version 1 och 2 has a more correct behaviour. If duplicates are found (two products with the same number), all unique products are returned. Before an error occured when this happened.
New (optional) structured option for method GetManyByIdentifiersQueued in both version 1 och 2: StructuredFilterOptions. You can filter the output products on product active status: All, Active or Expired.
New field on APIProduct
introduced in ProductService v2 for VVS: NameLongSvLong
. The field is not used for SEG.
The list containing ApiProductSVHCSubstance in the feature EnvironmentalData now contains up to six fields of SVHC Substances for SEG. For future use for VVS.
The field FrostSensible
is now obsolete and should not be used. It will always return null.
New read-only property on product:
New EnvironmentalData feature is now being launched:
A few more properties added to future container 'EnvironmentalData'. Do not use yet! New method in GlobalDataService: GetSVHCSubstances. For future use. Will only return empty list for now.
Note: A future container 'EnvironmentalData' will now be visible on the ApiProduct, which can be toggled to be shown with a new structuredOutputOption ('EnvironmentalData') - when released. It will always return null for now, and you should just ignore it!
Note: The outdated and should-not-be-used FlatService will be removed permanently.
One new ExtNumber type has been added: SCI (SCIP ID). Two new Uri types have been added: ENERGYMARKINGDOC (Produktblad energimärkning) and ENERGYMARKINGLABEL (Energimärkningsetikett).
Read more here: Reference lists
A new version of ProductService API is now available (version 2).
Improvements in ProductService v2:
Documentation can be found here: ProductService v2
A few new service operations in GlobalDataService have been added:
It is now possible to update ArticleAccessories
using the API. The container ArticleAccessoryFor
was never populated before, it is now. This bugfix applies to both version 1 and version 2 of ProductService.
Read more here: ApiArticleAccessory
VVS-2104
A new option ProductGroupsVersion
has been added in StructuredOutputOptions
This is the version of product group that should be returned. Default is active version. For VVS, set to 2 in order to retrieve the product's (or products') 4-level product group. The option is irrelevant for SEG.
New optional input parameter version
to GetProductGroups in Global data service. For VVS, set version=2 in order to retrieve 4-level product groups. The parameter is irrelevant for SEG.
Default is version 1.
New optional field in ApiProduct: PublishedAfterWholesaler
. Used to pre-release the product för wholesalers.
VVS-2058
The value list of ApiProductStorageRequirementTypes have been updated. Read more here
VVS-2108
TEST | 2020-09-03 |
PROD | 2020-09-10 |
New optional field: DangerousItemUnNumber
replaces now obsolete field: DangerousItem
DangerousItem
is now read-only with static value of None.
DangerousItemUnNumber
contains UN-number.
VVS-2076
TEST | 2020-08-31 |
PROD | 2020-09-10 |
We have added 6 new optional fields in ApiProduct:
BvbTotalAssessment
BvbLifecycleAssessment
BvbContentAssessment
BvbCaption
BvbImage
BvbUrl
Read more about the Bvb fields here
The fields cannot be updated, only read
VVS-1920
TEST | 2020-04-16 |
PROD | 2020-06-03 |
We have added a new property ProductMini in StructuredOutputOptions
This is for a future implementation and should not be used in this version.
The SOAP API Service contract has not changed.
VVS-1705
TEST | 2019-12-10 |
PROD | 2019-12-19 |
We have started building a REST API with functions from the SOAP API.
In this work we have changed a lot in the internal machinery of the API functions as they will serve two API interfaces in the future.
The SOAP API contract has not changed.
Now we have added the opportunity to run the SOAP API with https.
Add "secure" at the end of the URI to the web service
Example TEST: https://test.ws.vvsinfo.se/V1/ProductService.svc/secure
Example PROD: https://ws.vvsinfo.se/V1/ProductService.svc/secure
The GetManyByIdentifiersQueued feature has been in the API contract but has never been used. It also turned out to have a bug that we have now fixed.
You can submit the same type of identifiers (search keys) as for GetByIdentifier and GetSingleByIDentifier
If you send in identifiers that give duplicates of product, only one product is returned.
Articles that does not get a hit are NOT reported back because the API contract does not support this and we do not want to break it.
Note that this is an asynchronous method that returns a queue ID (QueueId). The result is usually checked with GetResult.
It is possible to use PingBackURL to get a signal when the result is clear.
Number of articles: Our recommendation is not to search for more than 500 items in a call.
We found that the GetUpdateResult method did not handle WorkNotReadyFault correctly.
This was due to a mismatch between the namespace for SOAP Faults in the SDK's proxy for the SOAP service and the SOAP service itself.
We had not updated SDK's proxy client at an earlier time.
The SDKs are now corrected and now they match.
-
Availability | Test 2019-11-27 |
Availability | PROD 2019-12-02 |
See ApiProduct External numbers (ApiProductExtNumber) for more information.
Internal ref numbers VVS-1618
Availability | Test 2019-09-20 |
Availability | PROD 2019-09-23 |
See ApiProduct Uri-types for more information.
Internal ref numbers VVS-1316
Availability | Test 2019-09-05 |
See About scaling of images for more information.
Internal ref numbers VVS-1559
Availability | Test 2019-09-04 |
When updating etimvalues server responded with error message
"Missing content access for field 'Etim.EFnnnnn'"even though user had access to ETIM-data.
Internal ref numbers VVS-1605
Availability | PROD 2019-09-09 |
See ApiProduct for more information.
Ignoring these fields in update methods
Internal ref numbers VVS-1604
Availability | PROD 2019-09-09 |
See ApiProduct for more information.
Note field DescriptionEn
DescriptionEn replaces the field NameLongEn for longer english description.
New meaning for NameLongEn which now contains the longer english name for the product.
Internal ref numbers VVS-1454, VVS-1423 and VVS-1581
Availability | Test 2019-08-20 |
See ApiProductPackage for more information.
Availability | Test 2019-08-13 |
As a manufacturer you can only search within your own products.
As a manufacturer you have to provide your own manufactureridentifuer or leave it blank
Have a look at ProductIdentifiers ByManufacturerAndArticleGTIN
Availability | Test 2019-05-08 |
Added Faultcontract InternalErrorFault to all methods in IProductService for a more robust error handling and return.
Availability | Test 2019-04-16 |
ProductService GetResult and GetUpdateResult wrongly returned a WorkNotProcessedException instead of WorkNotReadyException.
This now fixed.
Availability | Test 2019-03-27 | Prod 2019-03-27 |
Availability | Test 2019-03-12 | Prod 2019-03-13 |
See ApiProductPackage for more information.
Availability | Test 2018-1220 |
ReachVersionOfCandidateList
in ApiProduct for candidate list dateAvailability | Test 2018-12-07 |
Added fields CountWithDecimals and CountWithDecimalsIsSpecified, CountWithDecimals is also added as a return value.
For measurements M and M2 you have to use CountWithDecimals.
The field Count will remain, but is to be considered as obsolete and will be deprecated in the future.
The number of levels for ProductPackages changes from three to four by adding Mellan2 (SortOrder=3).
it is also possible to skip levels if desired.
All packages specified as level 3 (Top in the old specification) will be updated to level 4 prior to this update being released.
See ApiProductPackage for more information.
Availability | Test 2018-11-29 |
For Productservice Search.
Added parameter LastChangedOptionSearchGreaterThanOnly
for managing behaviour of comparision of lastChanged.
See SearchProductsParameters for more info.
Availability | TEST environment 2018-10-25 |
Added readonly fields in the following structures
ApiProduct.IndustrySpecificSEG
Availability | TEST environment 2018-10-23 |
In Productservice Search. Filter criteria didn't work for these fields in SearchProductsParameters.
Availability | TEST environment 2018-10-23 |
Bug occured when updating products.
For these fields
Availability | TEST environment 2018-10-16 |
Update info on Productservice.
Mainly behaviour on using product identifiers has been straightened up.
When using update functions as the role manufacturer you are only authorized to update your own products. Read more here.
Availability | TEST environment 2018-10-16 |
General information for the added field NumberStr on ApiProduct.
Availability | TEST environment 2018-09-28 |
The PingbackUrl Option when using SearchQueued and UpdateQueued is now enabled.
Availability | TEST environment 2018-09-26 |
As a manufacturer you may only search your own products. Please enter your ManufacturerId into search options. An error will be thrown otherwise.Productservice.
Notes on search parameters: SearchProductsParameters
Availability | TEST environment 2018-09-21 |
Added validation and restrictions on search options to use at least one esarch filter parameter.Productservice.
Notes on search parameters: SearchProductsParameters
Availability | TEST environment 2018-09-06 |
Added search options for searching by ProductGroupId or ProductGroupIdentifier in Productservice.
Notes on search parameters: SearchProductsParameters
Product Groups can be retreived with the method GetProductGroups
in GlobalDataService
Availability | TEST environment 2018-08-22 |
Updated UpdateArticlesInner in FlatService to just report ETIM-errors and not any existing errors on product.
Availability | PROD and TEST environment 2018-05-18 |
In Productservice.
Got System.NullReferenceException when trying to update a produt that does not exist.
Fixed so API now returns a better error message stating that the product could not be found and what product-key that caused the problem.
Availability | Test environment 2018-04-03 |
In Productservice.
Notes on properies and values : ApiProduct
An error occured when trying to update the properties StorageRequirement and DangerousItem
Availability | Test environment 2018-03-28 |
In Productservice.
Notes on properies and values : ApiProduct ApiEtimInfo
Updating ETIM-data is now supported.
(Documentation on this is currently a work in progress, we apologise for this)
Availability | Test environment 2018-03-27 |
In Productservice and CandidateService.
Error when updating or importing many products with the same picture/document. Only the first product was updated. wich resulted in File not found validation errors for the remainig products.
Availability | Test environment 2018-03-21 |
In Productservice.
Internal error when getting results from UpdateManyQueued using method GetUpdateResult
In Productservice Reference to Article/product in error messages was wronlgy prefixed with "MANU" insstead of "ART"
Availability | Test environment 2018-03-21 |
In Productservice.
Fields that can contain CRLF (x0D x0A) or just CR (x0D) is converted to LF (x0A)
Cleans invalid XML-characters from these fields as well.
W3-standard documentation about XML and Linebreaks
Affected fields in APiProduct
Availability | Test environment 2018-03-20 |
Fields that can contain CRLF (x0D x0A) or just CR (x0D) is converted to LF (x0A) W3-standard documentation about XML and Linebreaks Affected fields in APiProduct
Availability | Test environment 2018-03-15 |
Bugfix: Fixed UpdateManyQueued to correctly process all products. Only the first 10 were processed. Productservice
Availability | Test environment 2018-03-05 |
Bugfix: Fixed UpdateManyQueued to correctly update documents and images
Productservice
Documentation: Updated documentation for ApiProduct with field-lengths for string-fields
ApiProduct
Availability | Test environment 2018-03-02 |
Bugfix: Fixed GetByIdentifier-methods error when etim-group had enddate
Productservice
Availability | Test environment 2017-11-20 |
Bugfix: Fixed GetByIdentifier-methods error when searching by GTIN
Productservice
ProductIdentifiers
Availability | Test environment 2017-11-17 |
Bugfix: Fixed Get-methods returned duplicates of ETIM-data
Productservice
StructuredOptions
ApiProduct ApiEtimInfo
Availability | Test environment 2017-08-28 |
Added option to include ETIM-data for retrieved products in Get-methods
Productservice
StructuredOptions
ApiProduct ApiEtimInfo
Availability | Test environment 2017-07-18 |
Removed unsolved external reference to assembly. Moved tools code to project.
Availability | Test environment version 2017-R01 hotfix |
General support for the added field BulletText on ApiProduct.
Modified 2017-01-30 Field BulletText appears last.
Availability | version 2017-R01 |
Import methods of CandidateService and update methods of ProductService support new fields now
Availability | Test 2016-11-25 | Stage | Production |
Availability | Test 2016-11-24 | Stage | Production |
Availability | Test 2016-10-27 | Stage | Production |
Availability | Test 2016-10-20 | Stage | Production |
Availability | Test 2016-10-20 | Stage | Production |
Availability | Test 2016-10-07 | Stage | Production |
Availability | Test 2016-10-06 | Stage | Production |
Changed Names for the following types
ApiProduct Changes
Removed following types
ApiCandidateImportResult Changes
Availability | Test 2016-09-09 | Stage | Production |
Changed response type for ICandidateService.ImportWithGroupedResult to ApiCandidateImportGroupedResult
Bugfix: Import returns validation errors as it should. Bug returned duplcates.
ApiManufacturer Renamed following fields
Availability | Test 2016-09-09 | Stage | Production |
Updated ApiProduct with fields for manufacturer (Name Alias, Id and Identifier) Documentation for ApiProductManufacturer
Availability | Test 2016-08-10 | Stage | Production |
New service Documentation for ManufacturerService
Availability | Test 2016-06-07 | Stage | Production |
Candidate import
New method ImportWithGroupedResult
.
ApiProduct
CandidateService - Candidate Import
Candidate import and product update can take document parameters to upload documents and images.
Documentation for CandidateService
Documentation for ProductService
GlobalDataService
New methods GetProductGroups
GetUriTypes
.
Documentation for GlobalDataService
Availability | Test 2016-05-11 | Stage | Production |
Use parameter TakeApproximately
to split up huge results.
Availability | Test 2016-04-07 | Stage | Production |
All SOAP actions are now in correct namespace Prodibas.API.V1
, tempuri
has been removed.
Availability | Test 2015-12-10 | Stage 2016-04-04 | Production 2016-04-04 |
Methods GetUnits(), GetCountries(), GetDangerousItems(), GetStorageRequirements(), GetPackageTypes(), GetPackagingFunctions(), GetPalletTypes()
are now implemented.
Availability | Test 2015-12-10 | Stage 2016-04-04 | Production 2016-04-04 |
ModelValidationError
and ModelValidationException
are now in correct namespaces.
Availability | Test 2015-11-23 | Stage 2016-04-04 | Production 2016-04-04 |
For simplicity the ApiProduct<IndustrySpecificAbstractBase>
has been changed to ApiProduct
. You should still use property IndustrySpecific
for industry-specific information. This change gives you shorter and simpler class names in the WSDL contract.
Availability | Test 2015-11-23 | Stage 2016-04-04 | Production 2016-04-04 |
Availability | Test 2015-11-20 | Stage 2016-04-04 | Production 2016-04-04 |